技術問答
技術文章
iT 徵才
Tag
聊天室
2025 鐵人賽
登入/註冊
問答
文章
Tag
邦友
鐵人賽
搜尋
第 12 屆 iThome 鐵人賽
DAY
7
2
影片教學
想盡辦法當好一個Junior Backend Developer
系列 第
7
篇
Golang - 如何當好一個junior backend developer - 談談為何需要API Document
12th鐵人賽
肯尼攻城獅
團隊
不要搶我隊友
2020-09-20 20:25:05
3685 瀏覽
分享至
為什麼需要API Document
需求來了
前後端需要同時開工 後端先寫好API
雙方溝通的文件
何謂API Blueprint
特點
線上寫API文檔的平台
使用Markdown語法撰寫
支援團隊協作
支援Mock Server 方便前端可以透過Mock Data先做
支援版本管理(GitHub)
也可以local運行
缺點
存檔需手動存擋
線上寫文檔UI的反應有點慢
沒有所謂的codegen的tool
何謂Swagger
特點
API的開發工具
Swagger使用OpenAPI規範, 這個規範由 Linux 基金會主持,是為了建立世界各地共通的 API 規範。
使用語法可以用YAML或者JSON
Swagger延伸出來很多工具,例如:Swagger UI, Swagger Editor, Swagger Codegen, Swagger Hub
Swagger UI可以拿來自己本地deploy 自己維護API document server
Swagger Editor 為線上的編輯器
Swagger Codegen 自動產生Client 跟Server 的code 拿去當作Mock Server也可以
Swagger Hub 線上文檔平台 提供類似於API Bluepirnt的服務
Swagger的生態性相對於API Blueprint豐富很多 找解答會比較好找
針對Swagger Hub來說
UI等操作性比API Blueprint好
但免費版的只支持個人 團隊協作需要花錢
API Blueprint則是團隊開發可以免費 但有限制數量
總結
一開始的小團隊可以使用API Blueprint工具 整體來說還是比較輕量化
等到前後端都開發成熟後 可以考慮慢慢轉換到Swagger 可控性會更高
這次先用API BluePrint示範 有時間就用Swagger改寫
歡迎參觀團隊其他成員的文章~
前端工程師一起來種一棵後端技能樹吧!
用舒服的姿勢開發 Python Project
留言
追蹤
檢舉
上一篇
Golang - 如何當好一個junior backend developer - 來設計貓咪平台的schema吧
下一篇
Golang - 如何當好一個junior backend developer - 介紹如何操作API Blueprint及好用之處
系列文
想盡辦法當好一個Junior Backend Developer
共
13
篇
目錄
RSS系列文
訂閱系列文
15
人訂閱
9
Golang - 如何當好一個junior backend developer - 介紹如何撰寫API Blueprint 其實就是MD語法啦!
10
Golang - 如何當好一個junior backend developer - API Blueprint想要Local開發並且架設自己的API Document Server
11
Golang - 如何當好一個junior backend developer - 來認識Gin框架!
12
Golang - 如何當好一個junior backend developer - 講解Gin的簡單範例!
13
Golang - 如何當好一個junior backend developer - CRUD與Binding介紹!
完整目錄
熱門推薦
{{ item.subject }}
{{ item.channelVendor }}
|
{{ item.webinarstarted }}
|
{{ formatDate(item.duration) }}
直播中
立即報名
尚未有邦友留言
立即登入留言
iThome鐵人賽
參賽組數
902
組
團體組數
37
組
累計文章數
12018
篇
完賽人數
106
人
看影片追技術
看更多
{{ item.subject }}
{{ item.channelVendor }}
|
{{ formatDate(item.duration) }}
直播中
熱門tag
看更多
15th鐵人賽
16th鐵人賽
13th鐵人賽
14th鐵人賽
12th鐵人賽
11th鐵人賽
17th鐵人賽
鐵人賽
2019鐵人賽
javascript
2018鐵人賽
python
2017鐵人賽
windows
php
c#
windows server
linux
css
react
熱門問題
Esxi 8.0版本上的虛擬機器, 安裝的作業系統是Windows Server 2025, 確定輸入的密碼是正確的, 無法登入(顯示密碼錯誤)
因為網路磁碟的關係造成系統自動重新開機
windows server無法使用gpedit.msc
Java證照題目(main() method)
iatf16949資訊稽核
微軟更新重開機很久
iatf16949資訊稽核內容
請問有推蘪的server , vmware 防毒軟體嗎
瀏覽某網站,時間太長
部屬電腦如何讓每一台開始功能表跟工作列都一樣
熱門回答
iatf16949資訊稽核
Esxi 8.0版本上的虛擬機器, 安裝的作業系統是Windows Server 2025, 確定輸入的密碼是正確的, 無法登入(顯示密碼錯誤)
因為網路磁碟的關係造成系統自動重新開機
微軟更新重開機很久
請問有推蘪的server , vmware 防毒軟體嗎
熱門文章
第6天,憑證信任鏈 / 阿輝滷肉飯 浮洲市場小吃(新北板橋) | 30天滷肉飯
[為你自己學 n8n] 第 9 天,Google 大神駕到:串接服務的必修儀式!
第6天,Cloudflare CDN 全球節點 / 巨無霸懷念潤餅捲 | 30天板橋湳雅夜市
第7天,Cloudflare DNS 與 Proxy / 什錦燴飯 美味的飯 | 30天板橋湳雅夜市
第7天,公開金鑰基礎建設 PKI / 良友藥燉排骨枸杞土蝨 好甜的滷肉飯(台北大同) | 30天滷肉飯
IT邦幫忙
×
標記使用者
輸入對方的帳號或暱稱
Loading
找不到結果。
標記
{{ result.label }}
{{ result.account }}